home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / utildos2.arc / BANNER2.LBR / BANHELP.TXT < prev    next >
Encoding:
Text File  |  1985-03-02  |  12.3 KB  |  215 lines
  1.          FOR A PRINTED COPY OF THIS DOCUMENTATION, --> RUN "BANDOC.BAS".
  2.          *BANNER*  is  designed  to  help  you  get a message to the screen as
  3. easily  as  possible.  It  can  LOAD and SAVE files from disk, and includes an
  4. editor  with a user definable set of color keys to make *BANNER* color changes
  5. easy.  Entries  can be in UPPER or lower case throughout the program. When you
  6. see  <ENTER>,  this means press the ENTER or RETURN key (─┘) on the keyboard.
  7. <filename>  refers  to  a  file  specification as explained in the DOS Manual,
  8. section 1-5. 'xxx' means a number.
  9.          Choices  at  the  MAIN  MENU  can  be made in practically any way you
  10. choose. For instance you can:
  11.     o    1) Hit one of the <F>unction keys on the left side of the keyboard.
  12.  
  13.     o    2) Type the number of your choice and hit <ENTER>.
  14.  
  15.     o    3)  Type  the  CAPITOLIZED key word in the menu (upper or lower case)
  16.          and then hit <ENTER>.
  17.  
  18.     o    4) Use the arrow keys on the numeric keypad. When you hit <ENTER> the
  19.          choice indicated with the arrow () will be selected.
  20.  
  21.     o    5)  If  you want to LOAD or SAVE a *BANNER* file you have created, at
  22.          the  Main Menu you can type LOAD (or SAVE) "<filename>"<ENTER>; 3 (or
  23.          4) <ENTER>; <F3> (or <F4>); or SAVE (or LOAD) <ENTER>.
  24. ~
  25.          Your  *BANNER*  can  be  most  any  normal  key you can type from the
  26. keyboard,  from  ASCII  1  to  127.  See  the  BASIC  manual, section G for an
  27. explanation. The characters from 128 up are not available, since *BANNER* uses
  28. a  table  stored  in  permanent  memory  that  only  goes  up  to 127. Certain
  29. characters, like No. 1 () or No. 2 () or No. 14 () cannot be typed from the
  30. keyboard,  or  the  *BANNER*  editor.  Using  a  word-processor  to write your
  31. *BANNER*'s  might  allow  special  PC characters in your file. Use .BAN as the
  32. extension. MYFILE.BAN can be loaded by typing LOAD"MYFILE" in *BANNER*.
  33.  
  34.          There are only three characters from 1-127 that will not be displayed
  35. as  some  sort  of screen character: No. 13, No. 10, and No. 94. No. 13 is the
  36. carriage  return,  (<ENTER>)  which  ends  your  line. No. 10 is the line feed
  37. character, which breaks your line into two lines! No. 94 (^), the caret, has a
  38. special meaning to *BANNER*. This is how you change the colors on the screen!
  39.  
  40.          *BANNER*  can  display  any  color  combination--including flashing--
  41. possible  with  the  color adaptor. The caret character is used in combination
  42. with  a  hexadecimal  value  to  make what your color adaptor sees as a screen
  43. attribute.  Don't  worry! You don't have to learn hexadecimal to use *BANNER*.
  44. When you use the *BANNER* editor there is a set of colors at the bottom of the
  45. screen,  and  the  hex  digit that makes them up. Just hit the <F> key and the
  46. color will be in your *BANNER* !
  47. ~
  48.      ╔═══════════ *BANNER* color shorthand and how to do it! ════════════╗
  49.      ║  ┌── C O L O R S: ───┐  Form:  ^BF : B=BACKGROUND, F=FOREGROUND.  ║
  50.      ║  │  0    BLACK    8  │                                            ║
  51.      ║  │  1    BLUE     9  │  Both F and B can be any number from 0-F.  ║
  52.      ║  │  2    GREEN    A  │                                            ║
  53.      ║  │  3    CYAN     B  │  Values over 7 in BACKGROUND will create   ║
  54.      ║  │  4     RED     C  │  flashing.                                 ║
  55.      ║  │  5   MAGENTA   D  │                                            ║
  56.      ║  │  6    BROWN    E  │  Values over 7 in FOREGROUND make an       ║
  57.      ║  │  7    WHITE    F  │  intensified version of the first 0-7.     ║
  58.      ╚══╧═══════════════════╧════════════════════════════════════════════╝
  59.          For  example,  say  you  want a BLUE character on a BLACK background.
  60. BLACK  is  color 0, and BLUE is color 1. '^01' in your *BANNER* text will make
  61. the letters following '^01' BLUE on BLACK. To make FLASHING BLUE on BLACK, you
  62. would type '^81'. Here is a typical *BANNER* line:
  63.  
  64.  10 >^01The IBM Personal Computer ^A4a tool for modern times. ^10EXCELSIOR.
  65.  
  66.          '10  >' means this is line 10.'^01' makes 'The IBM Personal Computer'
  67. come  out  BLUE  on BLACK. '^A4' changes 'a tool for modern times' to FLASHING
  68. RED on GREEN. Then '^10' displays 'EXCELSIOR.' as BLACK on BLUE.
  69.          You  can  get a short onscreen summary of the color numbers by typing
  70. ?COL<ENTER> at COMMAND? level, or @?COL<ENTER> on a blank line while editing.
  71. ~
  72.                             *BANNER* DOT COMMANDS.
  73.          The  way  you change from full-screen mode to scrolling mode or pause
  74. the  display is with *BANNER* dot commands. This means that a dot is the FIRST
  75. character  on  the  line. *BANNER* text cannot be mixed with dot commands, but
  76. you can enter several dot commands on one line.
  77.  
  78.          Everything AFTER the command will be printed as described below:
  79.  
  80. o  .B  = *BANNER* mode. Screen is cleared, one line message will scroll to the
  81.          left.
  82.  
  83. o  .W  =  Window mode. Message is written on full-screen. Only 30 characters
  84.           fill the screen. Messages less than 30 are padded with blanks, if
  85.           your line is over 30 letters, it will be chopped off.  Color short-
  86.           hand (^BF) commands do not add to this count, in fact, every letter
  87.           could be specified a different color combination.
  88.  
  89. o    .WU =  Thirty characters scrolled UP the screen.
  90.  
  91. o    .WD =  Window is scrolled DOWN the screen.
  92.  
  93. o    .WR =  Window is written across the screen to the right.
  94. ~
  95.                      *BANNER* DOT COMMANDS ** CONTINUED **
  96.  
  97.          Other things that can be done during *BANNER*:
  98.  
  99. o  .P xxx =  Pause xxx after a line.  .p 2000 will pause a second. This is a
  100.              single-precision value and can be most any number.
  101.  
  102. o  .M  xx  =  Write a regular sized text message on screen at line xx. 1-25 If
  103.               this message is less than 80 letters, *BANNER* will center it.
  104. o  .C ^BF =  Used to specify the color for the message in .M above.
  105.  
  106. o  .D xxx =  Change the dots used to make up *BANNER* sized letters. Starts
  107.              out 2 (). Can be anything from 1-254. Others might be 219 (█),
  108.              or 220 (▄), or or 15 ().
  109.  
  110. o  .L xx  =  Change the starting line for the *BANNER* scroll to the left
  111.              routine. Starts out (line) 11. Can be 10-19.  The scrolling
  112.              *BANNER* can not be put at the top of the screen.
  113.  
  114. o  .N ^BF =  Change the screen attribute in the current *BANNER* window
  115.              without clearing the screen.
  116.  
  117. o  .S xxx =  Send xxx (1-254) spaces to *BANNER*. Clear out a line.
  118. ~
  119.       Here are some examples of the *BANNER* dot commands and what happens:
  120.  
  121.  11 >.p 2000  .c^04  .m 20 "Its not over until its over."
  122.  
  123.          The  '11  >'  says  that this is line 11. The first character on this
  124. line is a period, or dot, so this line will not be printed as a *BANNER*.
  125.          '.p'  tells  *BANNER* to pause and '2000' is the value to pause. This
  126. will be about one second.
  127.          '.c'  makes  a  new  color  for  a STATIONARY message; in other words
  128. standard  text printed on the screen--NOT a *BANNER*. '^04' says that the next
  129. stationary message will be printed RED on BLACK.
  130.          '.m'  is  the command to write a stationary message on the screen and
  131. '20' will put the message on line 20. If the message that follows is less than
  132. the  screen  width  of  80, *BANNER* will center the message on the line. Yogi
  133. Berra's comment will be printed RED on BLACK centered on line 20.
  134.  
  135. .d 219
  136.  
  137.          Since  there  is  no line number here, this line will be added to the
  138. END of the *BANNER* text buffer.
  139.          '.d'  will  change  the  text  character  used  to  make up the large
  140. *BANNER*  letters.  '219'  is  a  filled  box (█) so the letters will be bold.
  141. *BANNER*'s default dot is 2 (), the smiling face.
  142. ~
  143.                                *BANNER* EDITING.
  144.          The  *BANNER*  editor is a little like EDLIN with full-screen editing
  145. capabilities. There are two modes: COMMAND? and EDIT.
  146.          In COMMAND mode the prompt COMMAND? is displayed and you can LIST and
  147. PRINT(printer),  LOAD  and  SAVE files, and INSERT and DELETE lines. After you
  148. have  Listed  some  lines,  you  can  go to EDIT mode by hitting <ENTER> (─┘)
  149. alone,  and  Edit  the  lines  using the BASIC editing keys! If you just start
  150. typing lines they will be added to the END of the text.
  151.          LISTING  lines results in line numbering in the format: xx > where xx
  152. is  the  line  number.  This is how the editor allows you to edit all over the
  153. screen.
  154.  
  155.          In  EDIT  mode,  if you change a line NUMBER, the line that is there
  156. when  you  press <ENTER> becomes the line you have changed it to, unless it is
  157. numbered  higher  than  1+  the  current number of lines. *BANNER* won't allow
  158. lines that aren't consecutive, just like EDLIN.
  159.          Starting  a  blank  line  with  @  in  EDIT allows you to use all the
  160. COMMAND?'s without returning to Command Mode.
  161.          Typing  xxi>  will  INSERT a line at line number xx. xxd> will DELETE
  162. line xx. A complete summary of these commands follows on the next pages.
  163.          To make sure a line is entered, hit the <End> key before <ENTER>.
  164.          In  EDIT mode you can simply type in text and it will be added to the
  165. *BANNER* buffer, which can hold 200 lines of text.
  166. ~
  167.       ╔═══════════════════════ In COMMAND? mode: ══════════════════╗
  168.       ║                 xx,yy L  = List lines xx to yy.            ║
  169.       ║                       L  = List all lines.                 ║
  170.       ║                 xx    L  = List xx to 12+ xx.              ║
  171.       ║    P or xx P or xx,yy P  = Same as L but to the Printer.   ║
  172.       ║                 xx,yy D  = Delete lines xx to yy.          ║
  173.       ║                       D  = Delete all lines, start over.   ║
  174.       ║                 xx    D  = Delete line xx.                 ║
  175.       ║                 (xx)  I  = Insert at end or from line xx   ║
  176.       ║       LOAD "<filename>"  = Load from disk.                 ║
  177.       ║       SAVE "<filename>"  = Save to disk.                   ║
  178.       ║                 CLS      = Clear screen.                   ║
  179.       ║                 <ENTER>  = Start editing.                  ║
  180.       ║                 END or X = End editing session.            ║
  181. ╔═════╩════════════════════════════════════════════════════════════╩══════╗
  182. ║                 In EDIT mode, (no prompts, just a cursor):              ║
  183. ║  Typing any text without lines = Enter on highest line number.          ║
  184. ║                        xx >    = Following text goes on line xx.        ║
  185. ║               xxi> or  xxI>    = Insert a line at line xx.              ║
  186. ║               xxd> or  xxD>    = Delete line xx.                        ║
  187. ║                   <ENTER> or @ = Go back to COMMAND? mode.              ║
  188. ╚═════════════════ @<command>    = Do a COMMAND? from EDIT mode. ═════════╝
  189.                          Think 'sort of like EDLIN!'
  190. ~
  191.          In the Editor, quick command summaries can be displayed from COMMAND?
  192. mode by entering a ?. *BANNER* will then ask you what kind of help you want.
  193. To shorten this, you can type:
  194.  
  195.                 ? COM   = Help with COMMANDS          =  @? COM
  196. COMMAND? mode.  ? COL   = Help with color commands.   =  @? COL  EDIT mode.
  197.                 ? DOT   = Help with dot commands.     =  @? DOT
  198.                 ? ED    = Help with editing commands. =  @? ED
  199.  
  200.          You may notice that *BANNER* doesn't display on lines 1 to 9. This is
  201. due  to  the  way  the  color  adaptor  and your 8088 microprocessor work with
  202. display memory. In order to achieve the smooth scrolling of *BANNER* the video
  203. actually  has to be turned off while the main processor moves the *BANNER* one
  204. character  to  the left. When *BANNER* is through, the video is quickly turned
  205. back on, but in the process the top third of the screen gets blacked out. This
  206. is  why the *BANNER* background is always BLACK! If there were any other color
  207. on  the background you would see the blacking out of the screen. Any other way
  208. of  moving  a  third  of the screen, which is what *BANNER* does many times in
  209. 80-character  text  mode,  will  either  result  in  snow  on the screen or an
  210. unacceptably slow scroll.
  211.                              (c) 1983 Martin Smith
  212.         310 Cinnamon Oak Lane    COMPUSERVE 72155,1214 * SOURCE ST2259
  213.         Houston, Texas  77079    (713) 464-6737.    1/17/83
  214. ~
  215.